Interface PhysicalObject

All Superinterfaces:
IPCObject
All Known Implementing Classes:
PhysicalObjectImpl

public interface PhysicalObject extends IPCObject
Information provided by the PKI file:

    \class PhysicalObject
    
    \brief An object in the Physical Workspace.
    
    \example appWindow().getActiveWorkspace().getRootPhysicalObject()
    
Author:
Auto-generated
  • Method Details

    • getName

      String getName()
      Information provided by the PKI file:
      
          \brief Returns the name of this physical object
          
          \return QString, name of the object.
          
              
      Returns:
      String Returns a String
    • getType

      Information provided by the PKI file:
      
          \brief Returns the type of physical object.
          INTER_CITY = 0,
          CITY = 1,
          BUILDING = 2,
          WIRING_CLOSET = 3,
          RACK = 4,
          TABLE = 5,
          DEVICE = 6
          MULTIUSER = 7,
          GENERIC_CONTAINER = 8,
          
          \return PhysicalObjectType
          
              
      Returns:
      PhysicalObjectType Returns a PhysicalObjectType
    • getX

      int getX()
      Information provided by the PKI file:
      
          \brief Returns X coordinate.
          
          \return int, x coordinate.
          
              
      Returns:
      int Returns a int
    • getY

      int getY()
      Information provided by the PKI file:
      
          \brief Returns Y coordinate.
          
          \return int, y coordinate.
          
              
      Returns:
      int Returns a int
    • getCenterX

      int getCenterX()
      Information provided by the PKI file:
      
          \brief Returns center X coordinate.
          
          \return int, center x coordinate.
          
              
      Returns:
      int Returns a int
    • getCenterY

      int getCenterY()
      Information provided by the PKI file:
      
          \brief Returns center Y coordinate.
          
          \return int, center Y coordinate.
          
              
      Returns:
      int Returns a int
    • getGlobalX

      double getGlobalX()
      Information provided by the PKI file:
      
          \brief Returns global X coordinate.
          
          \return double, global x coordinate.
          
              
      Returns:
      double Returns a double
    • getGlobalY

      double getGlobalY()
      Information provided by the PKI file:
      
          \brief Returns global Y coordinate.
          
          \return double, global Y coordinate.
          
              
      Returns:
      double Returns a double
    • getDevice

      Device getDevice()
      Information provided by the PKI file:
      
          \brief Returns the device if the type is DEVICE
          
          \return Device, the device in the object type is DEVICE.
          
              
      Returns:
      Device Returns a Device
    • getParent

      PhysicalObject getParent()
      Information provided by the PKI file:
      
          \brief Returns the parent that contains the physical object.
          
          \return PhysicalObject, the parent that contains the physical object.
          
              
      Returns:
      PhysicalObject Returns a PhysicalObject
    • moveOutOfCurrentObject

      boolean moveOutOfCurrentObject()
      Information provided by the PKI file:
      
          \brief Moves the physical object out of the current parent object and returns whether it was successful.
          
          \return boolean, whether the move was successful.
          
              
      Returns:
      boolean Returns a boolean
    • moveIntoObject

      boolean moveIntoObject(String name)
      Information provided by the PKI file:
      
          \brief Moves the physical object into an object in the same level with the specified name and returns whether it was successful.
          
          \param name, the name of the object in the same level
          \return boolean, whether the move was successful.
          
              
      Parameters:
      name - Takes in a parameter of name
      Returns:
      boolean Returns a boolean
    • getChildCount

      int getChildCount()
      Information provided by the PKI file:
      
          \brief Returns the number of children the physical object has.
          
          \return int, the number of children the physical object has.
          
              
      Returns:
      int Returns a int
    • getChildAt

      PhysicalObject getChildAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the child at the given index in the physical object.
          
          \param index, index to get a child from.
          
          \return PhysicalObject, the child at the given index, if any.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      PhysicalObject Returns a PhysicalObject
    • getChild

      PhysicalObject getChild(String name)
      Information provided by the PKI file:
      
          \brief Returns the child with the specified name in the physical object.
          
          \param name, name of the child.
          
          \return PhysicalObject, the child with the specified name, if any.
          
              
      Parameters:
      name - Takes in a parameter of name
      Returns:
      PhysicalObject Returns a PhysicalObject
    • getChildByPath

      PhysicalObject getChildByPath(String path)
      Information provided by the PKI file:
      
          \brief Returns the child recursively with the specified path separated by comma (,) in the physical object.
          
          \param path, path of the child separated by comma (,).
          
          \return PhysicalObject, the child with the specified path, if any.
          
              
      Parameters:
      path - Takes in a parameter of path
      Returns:
      PhysicalObject Returns a PhysicalObject
    • setBackground

      void setBackground(String path, boolean tiled)
      Information provided by the PKI file:
      
          \brief Sets the background image path to use when inside the physical object.
          
          \param path, path to the image to use.
          \param tiled, true to tile the background false to just show one image.
          
              
      Parameters:
      path - Takes in a parameter of path
      tiled - Takes in a parameter of tiled
    • getBackground

      String getBackground()
      Information provided by the PKI file:
      
          \brief Sets the background image path to use when inside the physical object.
          
          \return QString, the background image path.
          
              
      Returns:
      String Returns a String
    • getEnvironment

      Environment getEnvironment()
      Information provided by the PKI file:
      
          \brief Gets the environment for the physical object.
          
          \return Environment, the environment for the physical object.
          
              
      Returns:
      Environment Returns a Environment
    • setX

      void setX(int x)
      Parameters:
      x - Takes in a parameter of x
    • setY

      void setY(int y)
      Information provided by the PKI file:
      
          \brief Sets the y-coordinate of the component item.
          
          \param y, the y-coordinate of the component item.
          
              
      Parameters:
      y - Takes in a parameter of y
    • moveBy

      void moveBy(int x, int y)
      Information provided by the PKI file:
      
          \brief Moves the component item by the specified x and y values.
          
          \param x, the value to move the component item by on the x-axis.
          \param y, the value to move the component item by on the y-axis.
          
              
      Parameters:
      x - Takes in a parameter of x
      y - Takes in a parameter of y
    • moveTo

      void moveTo(int x, int y)
      Information provided by the PKI file:
      
          \brief Moves the component item to the specified coordinates.
          
          \param x, the value to move the component item to on the x-axis.
          \param y, the value to move the component item to on the y-axis.
          
              
      Parameters:
      x - Takes in a parameter of x
      y - Takes in a parameter of y
    • getXScale

      double getXScale()
      Returns:
      double Returns a double
    • getYScale

      double getYScale()
      Returns:
      double Returns a double
    • getWidth

      double getWidth()
      Returns:
      double Returns a double
    • getHeight

      double getHeight()
      Returns:
      double Returns a double
    • setXVelocity

      void setXVelocity(double xv)
      Information provided by the PKI file:
      
          \brief Sets the x-axis velocity of the component item.
          
          \param xv, the x-axis velocity of the component item.
          
              
      Parameters:
      xv - Takes in a parameter of xv
    • setYVelocity

      void setYVelocity(double yv)
      Information provided by the PKI file:
      
          \brief Sets the y-axis velocity of the component item.
          
          \param yv, the y-axis velocity of the component item.
          
              
      Parameters:
      yv - Takes in a parameter of yv
    • setVelocity

      void setVelocity(double xv, double yv)
      Information provided by the PKI file:
      
          \brief Sets the x-axis and y-axis velocity of the component item.
          
          \param xv, the x-axis velocity of the component item.
          \param yv, the y-axis velocity of the component item.
          
              
      Parameters:
      xv - Takes in a parameter of xv
      yv - Takes in a parameter of yv
    • xVelocity

      double xVelocity()
      Information provided by the PKI file:
      
          \brief Returns the x-axis velocity of the component item.
          
          \return double, the x-axis velocity of the component item.
          
              
      Returns:
      double Returns a double
    • yVelocity

      double yVelocity()
      Information provided by the PKI file:
      
          \brief Returns the y-axis velocity of the component item.
          
          \return double, the y-axis velocity of the component item.
          
              
      Returns:
      double Returns a double
    • getPathUuid

      String getPathUuid()
      Information provided by the PKI file:
      
          \brief Returns the UUID of the physical object
          
          \return QString, the UUID of the physical object
          
              
      Returns:
      String Returns a String
    • nameToUuidPath

      String nameToUuidPath(String namePath)
      Information provided by the PKI file:
      
          \brief Returns the comma-separated UUID path of the physical object from the given comma-separated physical location name path
          
          \return QString, the comma-separated UUID path of the physical object from the given comma-separated physical location name path
          
              
      Parameters:
      namePath - Takes in a parameter of namePath
      Returns:
      String Returns a String
    • uuidToNamePath

      String uuidToNamePath(String uuidPath)
      Information provided by the PKI file:
      
          \brief Returns the comma-separated name path of the physical object from the given comma-separated physical location UUID path
          
          \return QString, the comma-separated name path of the physical object from the given comma-separated physical location UUID path
          
              
      Parameters:
      uuidPath - Takes in a parameter of uuidPath
      Returns:
      String Returns a String